Order Details
๐๏ธ Order Details from Third-Partyโ
This API is required to get Single/Basket Order details. Must be developed by the Third-party.
| Field | Value |
|---|---|
| Name | GetOrderDetails |
| URL | http://<third-party_domain>/GetOrderDetails |
| Description | Received order (meta data) from third-party will be sent to Trading application |
| Method | POST |
๐งพ Requestโ
Header
| Parameter | Description |
|---|---|
| Content-Type | application/json |
Body
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| ClientCode | String | M | Third-party application user |
| ProductCode | String | M | Unique "Product Code" entered at time of product creation; identifies the published product in the system |
| AuthCode | String | M | Generated by VAS system (Two-way auth code). |
| PartnerId | String | M | PartnerId of Broker's application used to execute the orders |
Example Request
{
"ClientCode": "WAVEUSER1",
"ProductCode": "EQBASKET",
"AuthCode": "auth_code_generated_by_system",
"PartnerId": "XXX-XXX-XX"
}
๐ Responseโ
| Parameter | Data Type | Mandatory/Optional | Description |
|---|---|---|---|
| success | Boolean | M | true โ Success, false โ Failure |
| data | String | M | JSON string, details of order |
| message | String | M | Success/Failure message for the API |
| statusCode | String | M | Application status code |
| traceId | String | M | System generated code by third-party, used for VAS log purpose |
| productCode | varchar(50) | M | Product code as stored in Odin VAS |
| productType | varchar(20) | M | Set default as BASKET |
| clientCode | varchar(50) | M | User Id |
| recoId | varchar(6) | M | Unique per each basket rebalance |
| orderSide | varchar(10) | M | Order side: BUY or SELL |
| mktSegId | Int | M | MarketSegmentID of the scrip |
| scripTkn | int | M | Scrip token of the scrip |
| ordType | Int | M | Order type |
| buyOrSell | Int | M | Buy = 1, Sell = 2 |
| orgQty | Int | M | Order quantity |
| discQty | int | M | Disclosed quantity |
| ordPrice | float | M | Order Price in paise |
| trigPrice | Float | M | Order trigger price in paise (Mandatory for stop loss orders only; pass 0 for others) |
| validity | Int | M | Validity of the order |
| days | varchar(10) | M | Number of days order needs to be carried ahead |
| ordGTD | int | M | 1 if GTD order, else 0 |
| prodType | char(1) | M | ProductType of the order |
| sLOrderPrice | float | M | Price in paisa |
| sLTriggerPrice | Float | M | SL Trigger Price in paisa |
** ๐ข Example Success Response**
{
"success": true,
"data": {
"sProductCode": "QuantechIndiaConsumptionFund",
"sProductType": "BASKET",
"sClientCode": "EMP081",
"sRecoId": "ODINBR016B",
"basketData": [
{
"ordPrice": 0,
"ordGTD": 0,
"prodType": "D",
"orderSide": "SELL",
"sLTriggerPrice": 0,
"buyOrSell": "2",
"sLOrderPrice": 0,
"orgQty": 10,
"mktSegId": 1,
"days": "0",
"scripTkn": 22,
"trigPrice": 0,
"validity": 1,
"ordType": 2,
"discQty": 0
}
]
},
"message": "success",
"statusCode": "prd-200-001",
"traceId": "511b2f00-36ba-4f30-a5bb-a071cebfee5b"
}
Example Failure Response
{
"success": false,
"data": null,
"message": "<respective error message>",
"statusCode": "400",
"traceId": "409dea70-df0d-4909-9321-b4f094f2ecc1"
}